Skip to main content

Project tech description

We made elements as reusable react components to build our application so we were able to use those elements on different pages with ease.

To switch between pages we used components from react-router-dom package that contains bindings for using React Router.

To create a database for storing, managing and providing information we used Firebase.

Each of the components has its own style written in SCSS. We used mixins and created variables, thanks to which our entire application is graphically consistent and compatible with any size device.

Project Setup#

Our program can be started directly by clicking on this link. To use the app - log in via google account

To run the project locally follow these steps:

  1. Clone this repository
  2. Open repository in your code editor
  3. Run command yarn install - without this you will not be able to run the app!
  4. Run command yarn start to activate the app in the development mode.
  5. Enter the local host that was created which by default is http://localhost:3000/

Notes (for Windows users):#

  • If you are a Windows user, please use Git Bash or any other UNIX-like shell (e.g. Git Bash). Some commands MAY NOT work on default Windows Command Line.
  • In addition, you may come across linebreak-style error because Windows enforces the usage of Windows line endings: \r\n - if it happens, use yarn format command and then error should not occur.

Tech requirements#

To run this project you have to:

  • Clone this repository
  • Run yarn install in root directory
  • Run yarn start to open live server

Other commands

  • yarn test - launches the test runner in the interactive watch mode
  • yarn lint - Checks every source code file using ESLint and rules described in .eslintrc
  • yarn format - formats entire project using Prettier according to formatting rules described in .prettierrc

Technologies used#

The program was created using the following technologies:

Flow#

Freeverse Database schema API actions

Resources#